home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 46 / Amiga Format CD46 (1999-10-20)(Future Publishing)(GB)[!][issue 1999-12].iso / -serious- / programming / other / vahunz / vahunz.readme < prev    next >
Text File  |  1999-09-06  |  3KB  |  105 lines
  1. TITLE
  2.  
  3.   vahunz - Make source code un-/more legible.
  4.  
  5. VERSION 
  6.  
  7.   1.6
  8.  
  9. AUTHOR
  10.  
  11.   Thomas Aglassinger <agi@giga.or.at>
  12.  
  13. DESCRIPTION
  14.  
  15.   Vahunz is a CLI-based replace command that can replace many words
  16.   across several files with only one invocation.
  17.  
  18.   Normally the target words will be created randomly, turning
  19.   meaningful names into unlegible garbage. For example, a function
  20.   name like read_input_file() could be replaced by g7B() or something
  21.   as useless. Additionally, comments and indention can be removed.
  22.  
  23.   As an option, you can specify specific substitutes, so Vahunz can
  24.   also be applied in a non-destructive manner. This can be used to
  25.   replace inconsistent, too short or unlegible names by something more
  26.   meaningful. Among programmers, this process is known as "The Great
  27.   Renaming".
  28.  
  29.   An Amiga Installer script acting as frontend to the CLI command is
  30.   included, so most tasks can be performed without having to deal with
  31.   cryptic command line options.
  32.  
  33. FEATURES
  34.  
  35.   - Stores less/more legible copy in a different directory
  36.   - Supports C, C++ and Java
  37.   - Auto-detects programming language
  38.   - New names since last run are easy to see
  39.   - Names can easily be declared to be modified or left untouched;
  40.     for example, it makes no sense to replace printf().
  41.   - Words being part of comments or string constants are not replaced
  42.   - Fast, as internally names are stored in an AVL-tree
  43.   - Several options to back-trace problems in vahunzed code
  44.   - Includes a set of standard dictionaries for various environments
  45.   - Includes source code (vahunzed ANSI C)
  46.  
  47. NEW FEATURES
  48.  
  49.   - Fixed some minor quirks
  50.   - Improved wording of error messages
  51.   - Added keywords for c9x (ISO C) and C++
  52.  
  53. SPECIAL REQUIREMENTS
  54.  
  55.   AmigaOS 2.04, 2MB of regular memory, 68020
  56.  
  57. AVAILABILITY
  58.  
  59.   - Every Aminet-mirror, file "dev/misc/vahunz.lha", for example:
  60.  
  61.     ftp://wuarchive.wustl.edu/pub/aminet/dev/misc/vahunz.lha
  62.  
  63.   - http://www.giga.or.at/~agi/vahunz/
  64.  
  65. PRICE
  66.  
  67.   Freeware.
  68.  
  69. DISTRIBUTABILITY
  70.  
  71.   Freely distributable as long the conditions described in the manual
  72.   are met.
  73.  
  74. EXAMPLE
  75.  
  76.   For example, one might have a code excerpt like this:
  77.  
  78.     int main(void)
  79.     {
  80.         while (sepp_age < 83)
  81.         {
  82.             grow_older(sepp_name, &sepp_age);
  83.             print_sepp();
  84.         }
  85.         printf("\n%s died.\n", sepp_name);
  86.         exit(EXIT_SUCCESS);
  87.     }
  88.  
  89.   After vahunzing, this is what it might look like:
  90.  
  91.     int main(void)
  92.     {
  93.     while (g8B < 83)
  94.     {
  95.     z3V(v6Z, &g8B);
  96.     f4V();
  97.     }
  98.     printf("\n%s died.\n", v6Z);
  99.     exit(EXIT_SUCCESS);
  100.     }
  101.  
  102.   As you can see, the internal names have been garbled, but the
  103.   symbols of the standard library are preserved.
  104.  
  105.